/**
 *  JFTSTool - Java Full Text Search tool.
 *  Copyright (C) <2009>  <grupo JFTS>
 *  This program is free software: you can redistribute it and/or modify
 *	it under the terms of the GNU General Public License as published by
 *	the Free Software Foundation, either version 3 of the License, or
 *	(at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.jftstool.result;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * Class that represents the result returned by JFTS.
 * @author grupo JFTS
 *
 */
public class JFTSResult implements Serializable {
	private static final long serialVersionUID = 1L;
	private int amount = 0;
	private List<IJFTSResultItem> documents;
	
	public JFTSResult(int amount, List<IJFTSResultItem> documents){
		this.amount = amount;
		this.documents = documents;
	}

	public int getAmount() {
		return amount;
	}
	
	public Iterator<IJFTSResultItem> getDocuementsIterator(){
		if (documents != null){
			return documents.iterator();
		}
		else{
			return new ArrayList<IJFTSResultItem>().iterator(); 
		}
	}
}
